Class WebViewImpl

java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.ui.impl.WebViewImpl
All Implemented Interfaces:
IPCObject, WebView

public class WebViewImpl extends IPCObjectImpl implements WebView
Information provided by the PKI file:

    \class WebView
    
    \brief WebView allows manipulation of WebViews such as the Instruction dialog and Script Modules.
    
    \example appWindow().getWebViewManager().getWebView("bca9d287-1eec-49a2-9bd2-ff83ef92f338")
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • getWebViewId

      public UUID getWebViewId()
      Information provided by the PKI file:
      
          \brief Returns the UUID of this WebView.
          
          \return uuid, the UUID of this WebView.
          
              
      Specified by:
      getWebViewId in interface WebView
      Returns:
      UUID Returns a UUID
    • evaluateToVariant

      public String evaluateToVariant(String scriptSource)
      Information provided by the PKI file:
      
          \brief Evaluates the specified script.
          
          \param scriptSource, the path or source of the script.
          
          \return QString, returns the a unique string to match result from generated event.
          
              
      Specified by:
      evaluateToVariant in interface WebView
      Parameters:
      scriptSource - Takes in a parameter of scriptSource
      Returns:
      String Returns a String
    • evaluateJavaScriptAsync

      public void evaluateJavaScriptAsync(String scriptSource)
      Information provided by the PKI file:
      
          \brief Evaluates the specified script asynchronously.
          
          \param scriptSource, the path or source of the script.
          
              
      Specified by:
      evaluateJavaScriptAsync in interface WebView
      Parameters:
      scriptSource - Takes in a parameter of scriptSource
    • setHtml

      public void setHtml(String html)
      Information provided by the PKI file:
      
          \brief Sets the HTML content of the WebView.
          
          \param html, the HTML content for the WebView.
          
              
      Specified by:
      setHtml in interface WebView
      Parameters:
      html - Takes in a parameter of html
    • setUrl

      public void setUrl(String url)
      Information provided by the PKI file:
      
          \brief Sets the URL of the WebView.
          
          \param url, the URL for the WebView.
          
              
      Specified by:
      setUrl in interface WebView
      Parameters:
      url - Takes in a parameter of url
    • getUrl

      public String getUrl()
      Information provided by the PKI file:
      
          \brief Returns the URL of the current page being displayed.
          
              
      Specified by:
      getUrl in interface WebView
      Returns:
      String Returns a String
    • getRequestedUrl

      public String getRequestedUrl()
      Information provided by the PKI file:
      
          \brief Returns the requested URL, which may be different than what getUrl() returns.
          
              
      Specified by:
      getRequestedUrl in interface WebView
      Returns:
      String Returns a String
    • show

      public void show()
      Information provided by the PKI file:
      
          \brief Shows the WebView.
          
              
      Specified by:
      show in interface WebView
    • hide

      public void hide()
      Information provided by the PKI file:
      
          \brief Hides the WebView.
          
              
      Specified by:
      hide in interface WebView
    • raise

      public void raise()
      Information provided by the PKI file:
      
          \brief Shows the WebView on top of other windows.
          
              
      Specified by:
      raise in interface WebView
    • setWindowTitle

      public void setWindowTitle(String title)
      Information provided by the PKI file:
      
          \brief Sets the window title of the WebView.
          
          \param title, the title for the WebView.
          
              
      Specified by:
      setWindowTitle in interface WebView
      Parameters:
      title - Takes in a parameter of title
    • setGeometry

      public void setGeometry(int x, int y, int width, int height)
      Information provided by the PKI file:
      
          \brief Sets the window position and geometry of the WebView.
          
          \param x, the x-coordinate for the WebView.
          \param y, the y-coordinate for the WebView.
          \param width, the width for the WebView.
          \param height, the height for the WebView.
          
              
      Specified by:
      setGeometry in interface WebView
      Parameters:
      x - Takes in a parameter of x
      y - Takes in a parameter of y
      width - Takes in a parameter of width
      height - Takes in a parameter of height
    • getX

      public int getX()
      Information provided by the PKI file:
      
          \brief Returns the x position of the webview.
          
              
      Specified by:
      getX in interface WebView
      Returns:
      int Returns a int
    • getY

      public int getY()
      Information provided by the PKI file:
      
          \brief Returns the y position of the webview.
          
              
      Specified by:
      getY in interface WebView
      Returns:
      int Returns a int
    • getWidth

      public int getWidth()
      Information provided by the PKI file:
      
          \brief Returns the width of the webview.
          
              
      Specified by:
      getWidth in interface WebView
      Returns:
      int Returns a int
    • getHeight

      public int getHeight()
      Information provided by the PKI file:
      
          \brief Returns the height of the webview.
          
              
      Specified by:
      getHeight in interface WebView
      Returns:
      int Returns a int
    • setMaximumSize

      public void setMaximumSize(int width, int height)
      Information provided by the PKI file:
      
          \brief Sets the maximum size of the web view.
          
              
      Specified by:
      setMaximumSize in interface WebView
      Parameters:
      width - Takes in a parameter of width
      height - Takes in a parameter of height
    • setMaximumWidth

      public void setMaximumWidth(int width)
      Information provided by the PKI file:
      
          \brief Sets the maximum width of the webview.
          
              
      Specified by:
      setMaximumWidth in interface WebView
      Parameters:
      width - Takes in a parameter of width
    • setMaximumHeight

      public void setMaximumHeight(int height)
      Information provided by the PKI file:
      
          \brief Sets the maximum height of the webview.
          
              
      Specified by:
      setMaximumHeight in interface WebView
      Parameters:
      height - Takes in a parameter of height
    • getMaximumWidth

      public int getMaximumWidth()
      Information provided by the PKI file:
      
          \brief Returns the maximum width of the webview.
          
              
      Specified by:
      getMaximumWidth in interface WebView
      Returns:
      int Returns a int
    • getMaximumHeight

      public int getMaximumHeight()
      Information provided by the PKI file:
      
          \brief Returns the maximum height of the webview.
          
              
      Specified by:
      getMaximumHeight in interface WebView
      Returns:
      int Returns a int
    • setMinimumSize

      public void setMinimumSize(int width, int height)
      Information provided by the PKI file:
      
          \brief Sets the minimum size of the web view.
          
              
      Specified by:
      setMinimumSize in interface WebView
      Parameters:
      width - Takes in a parameter of width
      height - Takes in a parameter of height
    • setMinimumWidth

      public void setMinimumWidth(int width)
      Information provided by the PKI file:
      
          \brief Sets the minimum width of the webview.
          
              
      Specified by:
      setMinimumWidth in interface WebView
      Parameters:
      width - Takes in a parameter of width
    • setMinimumHeight

      public void setMinimumHeight(int height)
      Information provided by the PKI file:
      
          \brief Sets the minimum height of the webview.
          
              
      Specified by:
      setMinimumHeight in interface WebView
      Parameters:
      height - Takes in a parameter of height
    • getMinimumWidth

      public int getMinimumWidth()
      Information provided by the PKI file:
      
          \brief Returns the minimum width of the webview.
          
              
      Specified by:
      getMinimumWidth in interface WebView
      Returns:
      int Returns a int
    • getMinimumHeight

      public int getMinimumHeight()
      Information provided by the PKI file:
      
          \brief Returns the minimum height of the webview.
          
              
      Specified by:
      getMinimumHeight in interface WebView
      Returns:
      int Returns a int
    • setPreferredSize

      public void setPreferredSize(int width, int height)
      Information provided by the PKI file:
      
          \brief Sets the preferred size of the webview.
          
              
      Specified by:
      setPreferredSize in interface WebView
      Parameters:
      width - Takes in a parameter of width
      height - Takes in a parameter of height
    • getPreferredWidth

      public int getPreferredWidth()
      Information provided by the PKI file:
      
          \brief Returns the preferred width of the webview.
          
              
      Specified by:
      getPreferredWidth in interface WebView
      Returns:
      int Returns a int
    • getPreferredHeight

      public int getPreferredHeight()
      Information provided by the PKI file:
      
          \brief Returns the preferred height of the webview.
          
              
      Specified by:
      getPreferredHeight in interface WebView
      Returns:
      int Returns a int
    • isFullScreen

      public void isFullScreen()
      Information provided by the PKI file:
      
          \brief Returns whether the webview is shown in full screen mode.
          
              
      Specified by:
      isFullScreen in interface WebView
    • showFullScreen

      public void showFullScreen()
      Information provided by the PKI file:
      
          \brief Shows the webview in full-screen mode.
          
              
      Specified by:
      showFullScreen in interface WebView
    • isMaximized

      public void isMaximized()
      Information provided by the PKI file:
      
          \brief Returns whether the webview is maximized.
          
              
      Specified by:
      isMaximized in interface WebView
    • showMaximized

      public void showMaximized()
      Information provided by the PKI file:
      
          \brief Shows the webview maximized.
          
              
      Specified by:
      showMaximized in interface WebView
    • isMinimized

      public void isMinimized()
      Information provided by the PKI file:
      
          \brief Returns whether this widget is minimized (iconified).
          
              
      Specified by:
      isMinimized in interface WebView
    • showMinimized

      public void showMinimized()
      Information provided by the PKI file:
      
          \brief Shows the webview minimized, as an icon.
          
              
      Specified by:
      showMinimized in interface WebView
    • showNormal

      public void showNormal()
      Information provided by the PKI file:
      
          \brief Restores the widget after it has been maximized or minimized.
          
              
      Specified by:
      showNormal in interface WebView
    • setWindowFlags

      public void setWindowFlags(WindowFlags flags)
      Information provided by the PKI file:
      
          \brief Sets the window flags for the WebView.
          
          \param flags,       the window flags.
          Window flags:
          Widget = 0x00000000,
          Window = 0x00000001,
          Dialog = 0x00000002 | Window,
          Sheet = 0x00000004 | Window,
          Drawer = Sheet | Dialog,
          Popup = 0x00000008 | Window,
          Tool = Popup | Dialog,
          ToolTip = Popup | Sheet,
          SplashScreen = ToolTip | Dialog,
          Desktop = 0x00000010 | Window,
          SubWindow = 0x00000012,
          ForeignWindow = 0x00000020 | Window,
          CoverWindow = 0x00000040 | Window,
          
          WindowType_Mask = 0x000000ff,
          MSWindowsFixedSizeDialogHint = 0x00000100,
          MSWindowsOwnDC = 0x00000200,
          BypassWindowManagerHint = 0x00000400,
          X11BypassWindowManagerHint = BypassWindowManagerHint,
          FramelessWindowHint = 0x00000800,
          WindowTitleHint = 0x00001000,
          WindowSystemMenuHint = 0x00002000,
          WindowMinimizeButtonHint = 0x00004000,
          WindowMaximizeButtonHint = 0x00008000,
          WindowMinMaxButtonsHint = WindowMinimizeButtonHint | WindowMaximizeButtonHint,
          WindowContextHelpButtonHint = 0x00010000,
          WindowShadeButtonHint = 0x00020000,
          WindowStaysOnTopHint = 0x00040000,
          WindowTransparentForInput = 0x00080000,
          WindowOverridesSystemGestures = 0x00100000,
          WindowDoesNotAcceptFocus = 0x00200000,
          MaximizeUsingFullscreenGeometryHint = 0x00400000,
          
          CustomizeWindowHint = 0x02000000,
          WindowStaysOnBottomHint = 0x04000000,
          WindowCloseButtonHint = 0x08000000,
          MacWindowToolBarButtonHint = 0x10000000,
          BypassGraphicsProxyWidget = 0x20000000,
          NoDropShadowWindowHint = 0x40000000,
          WindowFullscreenButtonHint = 0x80000000,
          
          
          
          WindowOkButtonHint = 0x00080000,
          WindowCancelButtonHint = 0x00100000
          
              
      Specified by:
      setWindowFlags in interface WebView
      Parameters:
      flags - Takes in a parameter of flags
    • getWindowFlags

      public WindowFlags getWindowFlags()
      Information provided by the PKI file:
      
          \brief Returns the window flags for the WebView. See setWindowFlags() for enum values.
          
              
      Specified by:
      getWindowFlags in interface WebView
      Returns:
      WindowFlags Returns a WindowFlags
    • setWindowModality

      public void setWindowModality(WindowModality modality)
      Information provided by the PKI file:
      
          \brief Sets the window modality for the WebView.
          
          \param modality,    the window modality.
          Window flags:       Qt::NonModal = 0,
          Qt::WindowModal = 1,
          Qt::ApplicationModal = 2,
          
              
      Specified by:
      setWindowModality in interface WebView
      Parameters:
      modality - Takes in a parameter of modality
    • setCanClose

      public void setCanClose(boolean bCanClose)
      Information provided by the PKI file:
      
          \brief Allows or disallows closing of the WebView.
          
          \param bCanClose, true to allow closing of the WebView, false to disallow.
          
              
      Specified by:
      setCanClose in interface WebView
      Parameters:
      bCanClose - Takes in a parameter of bCanClose
    • addAllowedExternalFilter

      public boolean addAllowedExternalFilter(String filter)
      Information provided by the PKI file:
      
          \brief Adds the specified external filter from the allowed external filter list.
          
          \param filter, the filter to add.
          
          \return bool, true if successful, otherwise false.
          
          \remark Allowed external filters manages which external sites/pages are allowed to access the Script Module. Filters are wildcards and not case sensitive.
          
          \example "http:
          
              
      Specified by:
      addAllowedExternalFilter in interface WebView
      Parameters:
      filter - Takes in a parameter of filter
      Returns:
      boolean Returns a boolean
    • removeAllowedExternalFilter

      public boolean removeAllowedExternalFilter(String filter)
      Information provided by the PKI file:
      
          \brief Removes the specified external filter from the allowed external filter list.
          
          \param filter, the filter of interest.
          
          \return bool, true if successful, otherwise false.
          
              
      Specified by:
      removeAllowedExternalFilter in interface WebView
      Parameters:
      filter - Takes in a parameter of filter
      Returns:
      boolean Returns a boolean
    • hasAllowedExternalFilter

      public boolean hasAllowedExternalFilter(String filter)
      Information provided by the PKI file:
      
          \brief Returns true if the specified filter is an allowed external filter, otherwise false.
          
          \return bool, true if the specified filter is an allowed external filter, otherwise false.
          
              
      Specified by:
      hasAllowedExternalFilter in interface WebView
      Parameters:
      filter - Takes in a parameter of filter
      Returns:
      boolean Returns a boolean
    • getAllowedExternalFilters

      public List<String> getAllowedExternalFilters()
      Information provided by the PKI file:
      
          \brief Returns the list of allowed external filters.
          
          \return vector<QString>, the list of allowed external filters.
          
              
      Specified by:
      getAllowedExternalFilters in interface WebView
      Returns:
      List<String> Returns a List<String>
    • clearAllowedExternalFilters

      public void clearAllowedExternalFilters()
      Information provided by the PKI file:
      
          \brief Clears all allowed external filters.
          
              
      Specified by:
      clearAllowedExternalFilters in interface WebView
    • close

      public void close()
      Information provided by the PKI file:
      
          \brief Closes the web view.
          
              
      Specified by:
      close in interface WebView
    • attachToMainViewArea

      public void attachToMainViewArea()
      Information provided by the PKI file:
      
          \brief Attaches the web view to the main view area. It hides the web view after calling this function. Requires calling show() to show it again.
          
              
      Specified by:
      attachToMainViewArea in interface WebView
    • detachFromMainViewArea

      public void detachFromMainViewArea()
      Information provided by the PKI file:
      
          \brief Detaches the web view from the main view area. It hides the web view after calling this function. Requires calling show() to show it again.
          
              
      Specified by:
      detachFromMainViewArea in interface WebView
    • isAttachedToMainViewArea

      public boolean isAttachedToMainViewArea()
      Information provided by the PKI file:
      
          \brief Returns whether the web view is attached to the main view area.
          
              
      Specified by:
      isAttachedToMainViewArea in interface WebView
      Returns:
      boolean Returns a boolean
    • dockToMainViewArea

      public void dockToMainViewArea()
      Information provided by the PKI file:
      
          \brief Docks the web view to the main view area. It hides the web view after calling this function. Requires calling show() to show it again.
          
              
      Specified by:
      dockToMainViewArea in interface WebView
    • undockFromMainViewArea

      public void undockFromMainViewArea()
      Information provided by the PKI file:
      
          \brief Undocks the web view from the main view area. It hides the web view after calling this function. Requires calling show() to show it again.
          
              
      Specified by:
      undockFromMainViewArea in interface WebView
    • isDockedToMainViewArea

      public boolean isDockedToMainViewArea()
      Information provided by the PKI file:
      
          \brief Returns whether the web view is docked to the main view area.
          
              
      Specified by:
      isDockedToMainViewArea in interface WebView
      Returns:
      boolean Returns a boolean
    • getDockWidgetWindowTitle

      public String getDockWidgetWindowTitle()
      Information provided by the PKI file:
      
          \brief Returns the dock widget window title.
          
              
      Specified by:
      getDockWidgetWindowTitle in interface WebView
      Returns:
      String Returns a String
    • setDockWidgetWindowTitle

      public void setDockWidgetWindowTitle(String title)
      Information provided by the PKI file:
      
          \brief Sets the dock widget window title.
          
          \param title, the title to set for the dock widget window title.
          
              
      Specified by:
      setDockWidgetWindowTitle in interface WebView
      Parameters:
      title - Takes in a parameter of title
    • setBackgroundColor

      public void setBackgroundColor(long argb)
      Information provided by the PKI file:
      
          \brief Sets the background color of the web view in #AARRGGBB format.
          
          \param argb, the background color in #AARRGGBB format
          
              
      Specified by:
      setBackgroundColor in interface WebView
      Parameters:
      argb - Takes in a parameter of argb
    • getBackgroundColor

      public long getBackgroundColor()
      Information provided by the PKI file:
      
          \brief Returns the background color of the web view in #AARRGGBB format.
          
              
      Specified by:
      getBackgroundColor in interface WebView
      Returns:
      long Returns a long
    • setZoomFactor

      public void setZoomFactor(double factor)
      Information provided by the PKI file:
      
          \brief Sets the zoom factor of this web view, ranging from 0.25 (zoomed out) to 5.0 (zoomed in), with default as 1.0.
          
          \param factor, the zoom factor
          
              
      Specified by:
      setZoomFactor in interface WebView
      Parameters:
      factor - Takes in a parameter of factor
    • getZoomFactor

      public double getZoomFactor()
      Information provided by the PKI file:
      
          \brief Returns the zoom factor of this web view, ranging from 0.25 (zoomed out) to 5.0 (zoomed in), with default as 1.0.
          
              
      Specified by:
      getZoomFactor in interface WebView
      Returns:
      double Returns a double
    • enableRightClickMenu

      public void enableRightClickMenu(boolean enable)
      Information provided by the PKI file:
      
          \brief Enables or disables the right click context menu.
          
              
      Specified by:
      enableRightClickMenu in interface WebView
      Parameters:
      enable - Takes in a parameter of enable